<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>WebCL: IWebCLKernel Interface Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">WebCL
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">IWebCLKernel Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="IWebCLKernel" -->
<p><a class="el" href="interfaceIWebCLKernel.html" title="IWebCLKernel interface abstracts a WebCL kernel.">IWebCLKernel</a> interface abstracts a WebCL kernel.  
 <a href="interfaceIWebCLKernel.html#details">More...</a></p>

<p><code>import &quot;<a class="el" href="IWebCLKernel_8idl_source.html">IWebCLKernel.idl</a>&quot;;</code></p>

<p><a href="interfaceIWebCLKernel-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLKernel.html#a6260279292d7d6087db0cdcf0f9cd502">getKernelInfo</a> (in long aName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get kernel info.  <a href="#a6260279292d7d6087db0cdcf0f9cd502"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">nsIVariant&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLKernel.html#aa4d9429583ae15b6d98d4f4f8bb05ddd">getKernelWorkGroupInfo</a> (in nsISupports aDevice, in long aName)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get kernel work group info.  <a href="#aa4d9429583ae15b6d98d4f4f8bb05ddd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLKernel.html#a14957e32b8c6a34c5f911e124285b244">setKernelArg</a> (in long aIndex, in nsIVariant aValue,[optional] in long aType)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the argument value for a specific argument of a kernel.  <a href="#a14957e32b8c6a34c5f911e124285b244"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLKernel.html#a078661556ef0e32ad52a61e828dbc4e4">setKernelArgLocal</a> (in long aIndex, in unsigned long aSize)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set local kernel argument.  <a href="#a078661556ef0e32ad52a61e828dbc4e4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceIWebCLKernel.html#a15d39b69df9ea37bb1530435db1ea633">releaseCLResources</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Immediately releases all OpenCL-related resources if any are allocated for this object.  <a href="#a15d39b69df9ea37bb1530435db1ea633"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interfaceIWebCLKernel.html" title="IWebCLKernel interface abstracts a WebCL kernel.">IWebCLKernel</a> interface abstracts a WebCL kernel. </p>
<dl class="see"><dt><b>See also:</b></dt><dd>cl_kernel </dd></dl>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6260279292d7d6087db0cdcf0f9cd502"></a><!-- doxytag: member="IWebCLKernel::getKernelInfo" ref="a6260279292d7d6087db0cdcf0f9cd502" args="(in long aName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCLKernel.html#a6260279292d7d6087db0cdcf0f9cd502">IWebCLKernel::getKernelInfo</a> </td>
          <td>(</td>
          <td class="paramtype">in long&#160;</td>
          <td class="paramname"><em>aName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get kernel info. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aName</td><td>Name of the info parameter. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting value. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clGetKernelInfo </dd>
<dd>
WebCL_types </dd></dl>

</div>
</div>
<a class="anchor" id="aa4d9429583ae15b6d98d4f4f8bb05ddd"></a><!-- doxytag: member="IWebCLKernel::getKernelWorkGroupInfo" ref="aa4d9429583ae15b6d98d4f4f8bb05ddd" args="(in nsISupports aDevice, in long aName)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nsIVariant <a class="el" href="interfaceIWebCLKernel.html#aa4d9429583ae15b6d98d4f4f8bb05ddd">IWebCLKernel::getKernelWorkGroupInfo</a> </td>
          <td>(</td>
          <td class="paramtype">in nsISupports&#160;</td>
          <td class="paramname"><em>aDevice</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in long&#160;</td>
          <td class="paramname"><em>aName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get kernel work group info. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aDevice</td><td>A WebCLDevice instance. </td></tr>
    <tr><td class="paramname">aName</td><td>Name of the info parameter. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The resulting value. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clGetKernelWorkGroupInfo </dd>
<dd>
WebCL_types </dd></dl>

</div>
</div>
<a class="anchor" id="a15d39b69df9ea37bb1530435db1ea633"></a><!-- doxytag: member="IWebCLKernel::releaseCLResources" ref="a15d39b69df9ea37bb1530435db1ea633" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCLKernel.html#a15d39b69df9ea37bb1530435db1ea633">IWebCLKernel::releaseCLResources</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Immediately releases all OpenCL-related resources if any are allocated for this object. </p>
<p>The object should not be used anymore after calling this function. </p>

</div>
</div>
<a class="anchor" id="a14957e32b8c6a34c5f911e124285b244"></a><!-- doxytag: member="IWebCLKernel::setKernelArg" ref="a14957e32b8c6a34c5f911e124285b244" args="(in long aIndex, in nsIVariant aValue,[optional] in long aType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCLKernel.html#a14957e32b8c6a34c5f911e124285b244">IWebCLKernel::setKernelArg</a> </td>
          <td>(</td>
          <td class="paramtype">in long&#160;</td>
          <td class="paramname"><em>aIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in nsIVariant&#160;</td>
          <td class="paramname"><em>aValue</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[optional] in long&#160;</td>
          <td class="paramname"><em>aType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set the argument value for a specific argument of a kernel. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aIndex</td><td>The argument index. </td></tr>
    <tr><td class="paramname">aValue</td><td>Value to be set. </td></tr>
    <tr><td class="paramname">aType</td><td>Type of the value to be set (one of WebCL.types) </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clSetKernelArg </dd>
<dd>
WebCL_types </dd></dl>

</div>
</div>
<a class="anchor" id="a078661556ef0e32ad52a61e828dbc4e4"></a><!-- doxytag: member="IWebCLKernel::setKernelArgLocal" ref="a078661556ef0e32ad52a61e828dbc4e4" args="(in long aIndex, in unsigned long aSize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="interfaceIWebCLKernel.html#a078661556ef0e32ad52a61e828dbc4e4">IWebCLKernel::setKernelArgLocal</a> </td>
          <td>(</td>
          <td class="paramtype">in long&#160;</td>
          <td class="paramname"><em>aIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">in unsigned long&#160;</td>
          <td class="paramname"><em>aSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Set local kernel argument. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">aIndex</td><td>The argument index. </td></tr>
    <tr><td class="paramname">aSize</td><td>Size of the local argument. </td></tr>
  </table>
  </dd>
</dl>
<dl class="see"><dt><b>See also:</b></dt><dd>clSetKernelArg </dd>
<dd>
WebCL_types </dd></dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>public/<a class="el" href="IWebCLKernel_8idl_source.html">IWebCLKernel.idl</a></li>
</ul>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 7 2012 12:59:51 for WebCL by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>
